@yarnpkg/libzip

What is @yarnpkg/libzip?

@yarnpkg/libzip is a library that provides functionalities for working with ZIP archives. It is part of the Yarn package manager's ecosystem and allows for creating, reading, and manipulating ZIP files programmatically.

What are @yarnpkg/libzip's main functionalities?

Creating a ZIP Archive

This code demonstrates how to create a ZIP archive and add a file to it using @yarnpkg/libzip. The `makeInterface` function initializes the libzip interface, and `ZipFS` is used to create and manipulate the ZIP file.

const { makeInterface } = require('@yarnpkg/libzip');
const { ZipFS } = require('@yarnpkg/fslib');

(async () => {
  const libzip = await makeInterface();
  const zipFs = new ZipFS(null, { libzip });

  zipFs.writeFileSync('/file.txt', 'Hello, world!');
  zipFs.saveAndClose();
})();

Reading a ZIP Archive

This code demonstrates how to read a ZIP archive and extract a file's content using @yarnpkg/libzip. The ZIP file is read from the filesystem, and `ZipFS` is used to access and read the file within the archive.

const { makeInterface } = require('@yarnpkg/libzip');
const { ZipFS } = require('@yarnpkg/fslib');
const fs = require('fs');

(async () => {
  const libzip = await makeInterface();
  const zipData = fs.readFileSync('archive.zip');
  const zipFs = new ZipFS(zipData, { libzip });

  const content = zipFs.readFileSync('/file.txt', 'utf8');
  console.log(content); // Outputs: Hello, world!
})();

Listing Files in a ZIP Archive

This code demonstrates how to list all files in a ZIP archive using @yarnpkg/libzip. The ZIP file is read from the filesystem, and `ZipFS` is used to list the files within the archive.

const { makeInterface } = require('@yarnpkg/libzip');
const { ZipFS } = require('@yarnpkg/fslib');
const fs = require('fs');

(async () => {
  const libzip = await makeInterface();
  const zipData = fs.readFileSync('archive.zip');
  const zipFs = new ZipFS(zipData, { libzip });

  const files = zipFs.readdirSync('/');
  console.log(files); // Outputs: ['file.txt']
})();

Other packages similar to @yarnpkg/libzip

adm-zip

ADM-ZIP is a pure JavaScript implementation for ZIP file handling. It provides similar functionalities to @yarnpkg/libzip, such as creating, reading, and extracting ZIP files. ADM-ZIP is widely used and has a straightforward API, making it a good alternative for ZIP file manipulation.

jszip

JSZip is a library for creating, reading, and editing .zip files with a JavaScript API. It is highly popular and well-documented, offering a range of features similar to @yarnpkg/libzip. JSZip is known for its ease of use and compatibility with both Node.js and browser environments.

node-stream-zip

node-stream-zip is a library for working with ZIP archives in a streaming manner. It allows for efficient reading and extraction of large ZIP files without loading the entire archive into memory. This makes it a good choice for handling large ZIP files compared to @yarnpkg/libzip.

README

@yarnpkg/libzip

This package contains a wasm-compiled version of the libzip.

Upgrade the libzip build

• Bump the version numbers in artifacts/build.sh
• Run the artifacts/build.sh script

Expose new functions

• Add the new functions to artifacts/exported.json
• List them in sources/index.ts
• Run the artifacts/build.sh script

Changelog

2.3.0

yarn set version 2.3.0

CLI

• The yarn tag set of commands has been ported over from Yarn Classic as yarn npm tag.
• Running yarn info will now print many information about your dependencies. Various options are available to tweak the output, including --json. Plugin authors can provide their own information sections via the fetchPackageInfo hook.
• Running yarn stage with the -r,--reset flag will now unstage all changes that seem related to Yarn.
• All commands now document each of their options (run yarn add -h to see an example).
• Publish registry errors will now be reported as is rather than being collapsed into a generic error message.
• A native binary jumper will now be used on Windows to avoid the Terminate batch job (Y/N)? prompts when invoking dependency binaries.

Installs

PnP API

The following changes only apply to the pnp linker (which is the default install strategy):

• The pnpapi module now exposes a new function called getAllLocators allow you to access the list of all locators in the map without having to traverse the dependency tree. This method is considered a Yarn extension, so you should check for its existence if you plan to use it in your code.
• When using a portal to a package that had peer dependencies, Yarn would loose the information required to resolve those peer dependencies. It will now properly resolve them the same way as all other packages in the dependency tree.

The following changes only apply to the node-modules linker:

• The bin symlinks will now be properly removed from the node_modules/.bin folder as their corresponding dependencies are removed.
• A new setting called nmHoistingLimits has appeared. It replaces what was previously known as nohoist in Yarn 1.
• We are now more forgiving for packages that make incorrect assumptions about the hoisting layout by first trying to maximize package exposure at the top-level. Only after the top-level has been populated will we deduplicate the remaining packages.
• Fixed some pathological cases around peer dependencies. In particular, workspaces' peer dependencies will now be resolved against their closest workspace ancestor (according to the directory hierarchy) rather than be ignored. Note that peer dependencies are inherently problematic with workspaces when using the node-modules linker, and that the strictly correct behavior can only be obtained by using the default Plug'n'Play linker.
• Running install after an interrupted install is supported now and will result in a consistent install state

Shell

• Added support for $$ and $PPID
• Fixes some pathological globbing problems.

Bugfixes

• The yarn constraints --fix command will now properly persist the changes on disk.
• The yarn unplug command will now work when used on packages with peer dependencies.
• The yarn stage command will now allow to stage files when called without the -c,--commit flag.
• Fixes a performance regression when using FSEvents.

Miscellaneous

• Removes extraneous subprocesses when using the yarnPath setting.

Third-party integrations

• Updated the VSCode SDK to take into account changes in the TypeScript server protocol.
• Added a few builtin extensions to improve compatibility with packages that weren't correctly listing their dependencies.
• Updated the TypeScript patch to cover TypeScript 4.1.